Skip to main content
Version: 1.0.2

About Bill Payment

Electronic Bill Payment services that are aggregated, processed and routed through Bill Payment aggregators. Currently it supports two aggregators.

  • MasterCard
  • ACI Worldwide
This API is used to invoke bill payments using RPPS and ACI channels.

Method: POST​

{{URL}}/jsonrpc

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription
Type

Mandatory

Enum

Valid Values:

  • REMITTANCE
  • CARDPAY
  • INTERNAL_TRANSFER
  • WITHDRAW
  • DEPOSIT
  • ADMIN_DEPOSIT
ReferenceId

Mandatory

String

Sample Value: REF0000000002

TimeStampString

Timestamp in the RFC3339 Format

Sample Value: 2020-04-22T07:44:55-05:00

PurposeCodeString

Sample Value: P101

Product

Mandatory

String

Sample Value: bizpay

Program

Mandatory

String

Sample Value: PL

InstructedAmount

Mandatory

  • Amount: Number

    Mandatory

    In Smallest Currency Unit

    Example: 7

  • Currency: String

    Mandatory

    Example: USD

FeeAmount
  • Amount: Number

    Mandatory

    In Smallest Currency Unit

    Example: 7

  • Currency: String

    Mandatory

    Example: USD

TaxAmount
  • Amount: Number

    Mandatory

    In Smallest Currency Unit

    Example: 1

  • Currency: String

    Mandatory

    Example: USD

DebtorAccount
  • AccountNumber: String

    Example: 98652221851

    Required only for ACH payment mode

  • InstitutionId: String

    Example: 101115302

  • Reference: String

    Example: txn000013

    Required only for PG, QRCODE, EFT, TELLER, BENEFIT, CHEQUE payment mode

  • Party:
    • AccountVerificationId: String

      Example: 5e9f246bd6571f2280d3d7b4

    • KycId: String

      Example: 5e9f1696d6571f272c5bcc0f

CreditorAccount
  • AccountNumber: String

    Mandatory

    Account Number from add account Response

    Sample Value: 9865321478

  • InstitutionId: String

    Sample Value: 011000028

  • IdentificationType: Enum

    Valid Values:

    • SAVINGS
    • CHECKINGS
    • WALLET
  • IFSCCode: String

    Sample Value: HDFC0001866

  • CardNumber: String

    Sample Value: 5102589999999913

  • ExpiryDate: String

    Expiry date in the YYYY-MM format

    Sample Value: 2022-12`

  • Party
    • Name: String

      Sample Value: John Deo

    • Identification: String

      Sample Value: 859630248

    • IdentificationType: String

      Sample Value: SSN

    • DateOfBirth: String

      Sample Value: 19930222

    • Address:
      • Line1: String

        Sample Value: 1200 street

      • Line2: String

        Sample Value: 2nd main road

      • TownName: String

        Sample Value: chennai

      • PostCode: String

        Sample Value: 600042

      • State: String

        Sample Value: TN

      • Country: String

        Sample Value: IN

    • Identification:
      • Type: String

        Type of Identification

        Sample Value: SSN

      • Value: String

        Identifying document number

        Sample Value: 324345435

    • PhoneNumber: String

      Sample Value: 45215478

MFP
  • IP: String

    Example: 10.3.254.143

  • WebBrowser: String

    Example: chrome

  • OperatingSystem: String

    Example: win

  • Latitude: String

    Example: 12.9703498

  • Longitude: String

    Example: 18.1561478

  • Model: String

    Example: HRA-001

  • Locality: String

    Example: Kansas

  • PostalCode: String

    Example: 50021


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{
    "method": "CustomerService.GetCustomer",
    "id": "1",
    "params": {
        "api": {
            "signature": "{{signature}}",
            "keyId": "67010",
            "credential": "Basic Key"
        },
        "payload": {
  "Type": "BILLPAY",
  "ReferenceId": "XXXMW202106160000021",
  "TimeStamp": "2020-06-16T07:44:55-05:00",
  "Product": "LEDGER",
  "Program": "PLCBWBANK",
  "InstructedAmount": {
    "Amount": 10000,
    "Currency": "USD"
  },
  "DebtorAccount": {
    "AccountNumber": "200643548027414",
    "IdentificationType": "WALLET",
    "Party": {
      "KycId": "2"
    }
  },
  "CreditorAccount": {
    "AccountNumber": "55658885",
    "CreditorAccountAgent": "ELECTRICITY & WATER AUTHORITY",
    "Party": {
      "Name": "RAJA"
    }
  }
}
}'

Body​

{
    "method": "TransactionService.Payment",
    "id": "1",
    "params": {
        "api": {
            "signature": "{{signature}}",
            "keyId": "6003",
            "credential": "Basic bWVsdmluQG5ldHhkLmNvbTpBZG1pbkAxMjM="
        },
        "payload": {
            "Type": "BILL_PAYMENT",
            "ReferenceId": "REF0100000038",
            "TimeStamp": "2020-04-22T07:44:55-05:00",
            "PurposeCode": "P101",
            "ProcessId": "PL0000001",
            "Product": "PL",
            "Program": "100000000005002",
            "InstructedAmount": {
                "Amount": 100,
                "Currency": "USD"
            },
            "DebtorAccount": {
                "AccountNumber": "200524894086671",
                "InstitutionId": "101115302"
            },
            "CreditorAccount": {}
        }
    }
}

Response: 200​

Response Parameters
ParameterDescription
method
Mandatory		String
API name
Constant : ledger.internal.transfer
id
Mandatory		String
Unique ID for Request
Example : 1
channel
Mandatory		String
Channel of transaction
Example : INTERNAL
transactionType
Mandatory		String
Type of transaction
Constant : INTERNAL_TRANSFER
product
Mandatory		String
Product in the transaction
Example : DEV
program
Mandatory		 String
Program in the transaction
Example : 200329026685021
transactionDateTime
Mandatory		String
Transaction timestamp
(format YYYY-MM-DD-HH-MM-SS)
Example : 2021-01-19 06:20:25
reference
Mandatory		String
Unique reference ID of transaction request
Example : REF1617049508172:0
reason
Optional		String
Reason for the transaction
Example : INTERNAL20210712100
transactionAmount.
amount
Mandatory		String
Transaction amount
Example : 200
transactionAmount.
currency
Mandatory		String
Currency in the transaction
Example : USD
debtorAccount.
identification
Mandatory		String
Debtor account number
Example : 200112335076623
debtorAccount.
identificationType
Mandatory		String
Debtor account type
Example : ACCOUNT_NUMBER
creditor.
identification
Mandatory		String
Identification number of creditor
Example : 200512645060836
creditor.
identificationType
Mandatory		String
Creditor account type
Example : ACCOUNT_NUMBER
api.type
Mandatory		String
Type of transaction request in API
Example : TRANSFER
api.credential
Mandatory		"Basic a2FydGhpays3MEB0ZXN0YmFuay5jb206ZjljM2IwYz
dlMzc1ZjgxM2Y1ZTAyN2QxODM4YzA4MWRmY
jEyMWFmZjYxZDk2YzA1NzQ="
api.signature
Mandatory		"hpays3MEB0ZXN0YmFuay5jb206ZjljM2IwYzdlMzc1ZjgxM2
Y1ZTAyN2QxODM4YzA4MWRmYjEyMWFmZjYxZDk2Yz"
api.apiKey
Mandatory		"f9c3b0c7e375f813f5e027d1838c081dfb121aff61d96c0574"

{
    "id": "1",
    "result": {
        "status": "COMPLETED",
        "timeStamp": "2020-04-22T07:44:55-0500",
        "TransactionID": "81248",
        "transactionNumber": "QA00000000010059",
        "referenceID": "REF0100000038",
        "processID": "PL0000001",
        "transactionAmount": 100
    }
}